4.8.4 修改用户目录
Path: /api/v1/userDirectory/update
Method: POST
接口描述:
- 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
- 不允许修改户目录的类型(type)、唯一标识(domain)
- 用户目录名称(name)不能相同
请求参数
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | string | 非必须 | 用户目录id | <2.2.16: 必传字段 >=2.2.16: 非必传字段,和用户目录名称至少需要传一个,都传时以id为主,且会以name的值更新用户目录名 |
|
name | string | 非必须 | 用户目录名称 | <2.2.16: 必传字段 >=2.2.16: 非必传字段,和用户目录id至少需要传一个,都传时以id为主,且会以name的值更新用户目录名 |
|
domain | string | 必须 | 唯一标识 | ||
config | object | 必须 | 用户目录配置 | ||
type | string | 必须 | 用户目录类型 | 示例:ldap | |
description | string | 非必须 | 描述 | ||
resourceGroupEditWay | string | 非必须 | set | 应用授权编辑方式: 'set'重置,'append'追加 | >=2.2.16: 支持 |
resourceGroupIdList | string[] | 非必须 | 应用分类ID列表 | ||
resourceGroupNameList | string[] | 非必须 | 应用分类ID列表 | >=2.2.16: 支持, 与resourceGroupIdList同时使用时以resourceGroupIdList为准 | |
resourceEditWay | string | 非必须 | set | 应用分类授权编辑方式: 'set'重置,'append'追加 | >=2.2.16: 支持 |
resourceIdList | string[] | 非必须 | 应用ID列表 | ||
resourceNameList | string[] | 非必须 | 应用名称列表 | >=2.2.16: 支持, 与resourceIdList同时使用时以resourceIdList为准 |
请求示例
{
"id": "c1085980-a3da-11eb-ab69-8353f1c26be3",
"status": 1,
"name": "idldap-test",
"description": "",
"domain": "idldap-test.com",
"authComposeId": "c109e020-a3da-11eb-ab69-8353f1c26be3",
"authComposeName": "默认策略",
"type": "ldap",
"config": {
"type": "ad",
"syncConfig": {
"syncTime": {
"period": 86400000
},
"cleanDeleted": {
"enable": 1,
"interval": 168
}
},
"templateId": "3b52d0e4-e178-4bef-aef2-95eaf91adeeb",
"interfaceStatus": 1,
"externalUserServerConfig": {
"type": "ad",
"serverIp": "192.168.1.2",
"directory": {
"type": "ldap",
"subtype": "default"
},
"bandFilter": "(&(CN=*)&(ObjectClass=group))",
"reqTimeout": "15",
"userFilter": "(objectCategory=person)",
"groupFilter": "(ou=*)",
"adminAccount": "test@test.com",
"adminPassword": "♂♀☺♪♫◙♂1",
"serverAddress": "ldap://192.168.1.2",
"sAMAccountName": "sAMAccountName",
"searchEntrance": "OU=test,DC=test,DC=com",
"serverProtocol": "ldap://",
"bandAttrMapping": {
"name": "cn",
"externalId": "objectGUID",
"description": "description"
},
"interfaceStatus": 1,
"userAttrMapping": {
"name": "uid",
"band": "memberOf",
"path": "ou",
"email": "mail",
"phone": "telephoneNumber",
"status": "userAccountControl",
"externalId": "objectGUID",
"description": "description",
"expiredTime": "accountExpires"
},
"groupAttrMapping": {
"name": "ou",
"externalId": "objectGUID",
"description": "description"
},
"pwdModel": "clear"
},
"forbidUnimportedUserLogin": 1,
"unImportedUserAuthOption": {
"behavior": "default"
}
},
"hasBoundToCertServer": 0,
"resourceEditWay": "set",
"resourceIdList": [],
"resourceNameList": [],
"resourceGroupEditWay": "append",
"resourceGroupIdList": [],
"resourceGroupNameList": []
}
返回示例
{
"code": 0,
"data": {},
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
参数检查出错 | 10000001 |
https认证模板不存在 | 77200001 |
用户目录不存在 | 7521 |
默认用户目录,不允许修改、删除 | 77200008 |
用户目录不存在 | 77200001 |
同步任务正在执行中,不允许修改、删除 | 77200008 |
用户最多关联1000个应用 | 77200007 |
保存失败,关联的应用不存在或已被删除 | 77200004 |
保存失败,关联的应用分类不存在或已被删除 | 77200004 |
不可编辑用户目录唯一标识 | 77200006 |
不可编辑用户目录管理接口状态 | 77200009 |
不可编辑用户目录管理类型 | 77200009 |
用户目录名(%s)已存在 | 77200005 |
保存失败 | 10000000 |